Add stubs for the stdlib _colorize module - #16370
Open
anistark wants to merge 1 commit into
Open
Conversation
`_colorize` has been available since Python 3.13 and gained the experimental theming API in 3.14, which was extended considerably in 3.15. The stub covers all three versions: - 3.13+: `COLORIZE`, `ANSIColors`, `NoColors`, `get_colors`, `can_colorize` - 3.14+: `ColorCodes`, `decolor`, `ThemeSection`, the `Argparse`, `Syntax`, `Traceback` and `Unittest` sections, `Theme`, `get_theme` and `set_theme` - 3.15+: `CursesColors`, `BackgroundStyle`, ten further theme sections, and the `kw_only` dataclass signatures that 3.15 switched to `attr` and `code` are loop variables that leak into the module namespace, and `BackgroundStyle` is declared with the `type` statement, which stubtest compares against the alias value; all three are allowlisted. Closes python#16361
Contributor
|
According to mypy_primer, this change has no effect on the checked open source code. 🤖🎉 |
srittau
requested changes
Sep 10, 2026
srittau
left a comment
srittau
left a comment
Collaborator
There was a problem hiding this comment.
Not a full review yet, but a few things I noticed. In general, the stub file should use the same ordering as the implementation, even if it means repeating version info checks.
| BOLD: str | ||
| GREY: str | ||
|
|
||
| NoColors: ANSIColors |
Collaborator
There was a problem hiding this comment.
Suggested change
| NoColors: ANSIColors | |
| NoColors: Final[ANSIColors] |
Comment on lines
+61
to
+62
| if sys.version_info >= (3, 14): | ||
| ColorCodes: set[str] |
Collaborator
There was a problem hiding this comment.
Let's move this directly above NoColors so it matches the source order. Also let's make it final.
Comment on lines
+58
to
+59
| def get_colors(colorize: bool = False, *, file: IO[str] | IO[bytes] | None = None) -> ANSIColors: ... | ||
| def can_colorize(*, file: IO[str] | IO[bytes] | None = None) -> bool: ... |
Collaborator
There was a problem hiding this comment.
IO should be avoided in argument positions. In this case it should be a protocol with one optional item fileno. Since optional protocol items are not yet supported (see python/typing#601), the best we can do is probably something like this:
Suggested change
| def get_colors(colorize: bool = False, *, file: IO[str] | IO[bytes] | None = None) -> ANSIColors: ... | |
| def can_colorize(*, file: IO[str] | IO[bytes] | None = None) -> bool: ... | |
| # A protocol with an optional `fileno(self) -> int: ...` member. | |
| _MaySupportFileno: TypeAlias = Any | |
| def get_colors(colorize: bool = False, *, file: _MaySupportFileno | None = None) -> ANSIColors: ... | |
| def can_colorize(*, file: _MaySupportFileno | None = None) -> bool: ... |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
_colorizehas been available since Python 3.13 and gained the experimental theming API in 3.14, which was extended considerably in 3.15. The stub covers all three versions:COLORIZE,ANSIColors,NoColors,get_colors,can_colorizeColorCodes,decolor,ThemeSection, theArgparse,Syntax,TracebackandUnittestsections,Theme,get_themeandset_themeCursesColors,BackgroundStyle, ten further theme sections, and thekw_onlydataclass signatures that 3.15 switched toattrandcodeare loop variables that leak into the module namespace, andBackgroundStyleis declared with thetypestatement, which stubtest compares against the alias value; all three are allowlisted.Closes #16361